<!DOCTYPE html>
<!--
File:      index.html
Author:    Henry Feild
Date:      March 2013
Purpose:   Serves as the primary page for viewing CLRM API documentation. All
           other pages are loaded into this page.

%%COPYRIGHT%%

Version: %%VERSION%%
-->
<html>
<head>    
    <!-- type="image/png" -->
    <link rel="shortcut icon" type="image/png"
        href="css/img/crowdlogger-logo.001.16x16.png"/>

    <title>Remote Module API</title>
    <link href="css/dialog.css" media="all" rel="stylesheet" type="text/css"/>
    <link href="css/page.css" rel="stylesheet" type="text/css"/>
    <link href="js/external/google-code-prettify/prettify.css" rel="stylesheet" type="text/css"/>
    <script src="js/external/jquery.min.js"></script>
    <script src="js/external/google-code-prettify/prettify.js"></script>
    <script src="js/page.js"></script>

</head>
<body>
<span class="hidden" id="init"></span>


<div class="menu">
    <!-- Home -->
    <div class="menu-item">
        <span class="non-trigger">&#9658;</span>
        <a href="#home">Home</a>
    </div>

    <!-- Implementing -->
    <div class="menu-item">
        <span class="non-trigger">&#9658;</span>
        <a href="#implement">Implementing</a>
    </div>

    <!-- Executing -->
    <div class="menu-item">
        <span class="trigger toggle expanded hidden">&#9660;</span>
        <span class="trigger toggle collapsed">&#9658;</span>         
        <a href="#execute">Using a CLRM</a>
        <div class="sublist toggle expanded hidden">
            <span class="menu-item">
                <a href="#execute:which-publishing-method">Which publishing method</a>
            </span><br/>
            <span class="menu-item">
                <a href="#execute:crowdlogger-server">Publish on a CrowdLogger server</a>
            </span><br/>
            <span class="menu-item">
                <a href="#execute:self-publish">Self publish</a>
            </span>
        </div>
    </div>    

    <h2>API</h2>
    <!-- User API -->
    <div class="menu-item">
        <span class="trigger toggle expanded hidden">&#9660;</span>
        <span class="trigger toggle collapsed">&#9658;</span> 
        <a href="#user">User</a>
        <div class="sublist toggle expanded hidden">
            <span class="menu-item">
                <a href="#user:history">User history</a>
            </span><br/>
            <span class="menu-item">
                <a href="#user:realtime">Real-time activity</a>
            </span>
        </div>
    </div>

    <!-- Global Data API -->
    <div class="menu-item">
        <span class="non-trigger">&#9658;</span>
        <a href="#global-data">Global Data</a>
    </div>

    <!-- User Interface API -->
    <div class="menu-item">
        <span class="trigger toggle expanded hidden">&#9660;</span>
        <span class="trigger toggle collapsed">&#9658;</span> 
        <a href="#ui">User Interface</a>
        <div class="sublist toggle expanded hidden">
            <span class="menu-item">
                <a href="#ui:standalone">Stand-alone app</a>
            </span>
            <span class="menu-item">
                <a href="#ui:crowdlogger">CrowdLogger widget</a>
            </span>
            <span class="menu-item">
                <a href="#ui:contentScripts">Content scripts</a>
            </span>
        </div>
    </div>            

    <!-- Storage -->
    <div class="menu-item">
        <span class="trigger toggle expanded hidden">&#9660;</span>
        <span class="trigger toggle collapsed">&#9658;</span>
        <a href="#storage">Storage</a>
        <div class="sublist toggle expanded hidden">
            <span class="menu-item">
                <a href="#storage:storage">Database storage</a>
            </span>
            <span class="menu-item">
                <a href="#storage:preferences">Preferences</a>
            </span>
        </div>
    </div>

    <!-- User Interface API -->
    <div class="menu-item">
        <span class="trigger toggle expanded hidden">&#9660;</span>
        <span class="trigger toggle collapsed">&#9658;</span> 
        <a href="#privacy">Privacy</a>
        <div class="sublist toggle expanded hidden">
            <span class="menu-item">
                <a href="#privacy:encryption">Encryption</a>
            </span><br/>
            <span class="menu-item">
                <a href="#privacy:ss">Secret sharing</a>
            </span>
            <span class="menu-item">
                <a href="#privacy:anonymization">Anonymized uploading</a>
            </span>
        </div>
    </div> 

    <!-- Server-side communication -->
    <div class="menu-item">
        <span class="trigger toggle expanded hidden">&#9660;</span>
        <span class="trigger toggle collapsed">&#9658;</span> 
        <a href="#server-side">Server-side access</a>
        <div class="sublist toggle expanded hidden">
            <span class="menu-item">
                <a href="#server-side:data">Data resource</a>
            </span><br/>
            <span class="menu-item">
                <a href="#server-side:computation">Computations</a>
            </span>
        </div>
    </div> 

    <!-- Examples -->
    <h2>Examples</h2>
    <!-- Search Task Assitant -->
    <div class="menu-item">
        <span class="non-trigger">&#9658;</span>
        <a href="#examples/pqq">Post query questionnaire</a>
        <!-- <a href="#examples/sta">Search Task Assistant</a> -->
    </div>

</div>


<div class="bodyWrapper">

    <!-- The header. -->
<!--     <div class="header">
        <div class="title"> 
            <img class="logo" src="../../css/img/crowdlogger-logo.002.png"/>
            <span class="titleMain">Remote Module API</span><br>
        </div>
    </div> -->

    <div class="header">
        <div class="title with-logo"> 
            <span class="logo-version version titleSub">version %%VERSION%%</span>
            <img class="logo" src="css/img/crowdlogger-logo.002.png"/>
            <span class="titleMain">Remote Module API</span>
        </div>
    </div>
    
    <!-- Brings us down to just below the title. -->
    <div style="clear: both;"></div>
    <div class="headerBuffer"></div>


    <iframe id="tmp-contents" style="border: none" class="hidden">
    </iframe>

    <div id="contents">
        here
    </div>

    <!-- Everything below here is for the footer. -->
    <div class="buffer">
    </div>
        
    <div class="footer" >
        <div class="copyright">
        %%LICENSE_WEB%%
        </div>
    </div>
</div>
<div class="emptyFooter">
</div>
</body>
</html>
